-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Remove redundant documentation from /docs #10557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @Liongrass, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a documentation cleanup initiative within the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request cleans up the repository by removing three outdated or misplaced documentation files: etcd.md, nat_traversal.md, and ruby-thing.rb. The reasoning for each removal is sound. I've found one issue: the removal of etcd.md leaves a broken link in docs/INSTALL.md. I've added a comment with details on how to fix this. Once that's addressed, this PR will be a good improvement.
| @@ -1,85 +0,0 @@ | |||
| # Experimental etcd support in LND | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While removing this documentation for the experimental etcd support is a good cleanup step, there's a lingering reference to this file in docs/INSTALL.md that should also be removed to avoid a broken link.
In docs/INSTALL.md on line 257, the following line should be removed:
- [kvdb_etcd](/docs/etcd.md)Since docs/INSTALL.md is not part of this pull request, you will need to add this change to resolve the broken link.
🟢 PR Severity: LOW
🟢 Low (3 files)
AnalysisThis PR removes outdated documentation files from the repository:
Severity Rationale: Documentation-only changes fall under the LOW severity category per the classification rules. These deletions:
This is a straightforward cleanup PR that improves documentation organization without any technical risk. To override, add a |
🟢 PR Severity: LOW
🟢 Low (4 files)
AnalysisThis PR removes redundant documentation files from the According to the severity classification rules, documentation files ( Recommendation: This is safe to merge after a quick review to ensure the removed documentation is indeed redundant and not referenced elsewhere. To override, add a |
🟢 PR Severity: LOW
🟢 Low (4 files)
AnalysisThis PR removes redundant documentation from the The PR is a pure cleanup operation:
Recommendation: This can be reviewed by any maintainer familiar with the documentation structure. No specialized domain knowledge is required. To override, add a |
Change Description
In an attempt to clean up the in-repository documentation, I propose to remove three older documents from
lnd/docs.etcd.md: Etcd support was introduced in v0.11 but never progressed beyond "experimental." We never recommended this feature and likely never will.nat_traversal: While a useful feature, this kind of short guide would better be placed in the Builder's Guide repositoryruby-thing.rb: This file appears to be created to generated a Table of Contents. It was last edited eight years ago and I don't have a guess for what it could be useful for.